package com.fxu.framework.core.enums;

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;

/**
 * 枚举字段校验注解
 * <p>当字段为null ( 或者target() == null )，不进行比较，必须显式使用注解@NotNull</p>
 * @author fangxu
 * @version 1.0.0
 */
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(
    validatedBy = { EnumValidator.class }
)
public @interface EnumValid {
    /**
     * 错误提示信息
     * @return 返回错误消息
     */
    String message() default "Enumeration verification failed";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};

    /**
     * 检验枚举类
     * @return 目标类
     */
    Class<? extends BaseEnum> target();
}